docs: logical DIP coordinate space contract - #21
Merged
Conversation
All mouse/pointer/scroll coordinates are in logical DIP (device-independent pixels), consistent with WindowProvider.Size(). Explicitly document that callers should NOT divide by ScaleFactor — DPI scaling is applied internally by the framework on all platforms. Motivated by gogpu#398: user double-scaled coordinates because the godoc did not clearly state the coordinate space contract.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents that all mouse/pointer/scroll coordinates in the
EventSourceandPointerEvent/ScrollEventtypes are in logical DIP (device-independent pixels), consistent withWindowProvider.Size().Explicitly states: do NOT divide by
ScaleFactor()— DPI scaling is applied internally by the framework on all platforms.Motivation
gogpu#398: @unxed's f4 file manager divided mouse coordinates by
ScaleFactor(), causing double-scaling on Windows HiDPI (125%/150%). The existing godoc said "Uses logical pixels (CSS pixels equivalent)" which was technically correct but did not explicitly warn against manual scaling.Changes
events.go— block comment above mouse event methods + per-method "x, y are in logical DIP"pointer.go—PointerEvent.X/Ygodoc: explicit "Do NOT divide by ScaleFactor"scroll.go—ScrollEvent.X/Ygodoc: "logical DIP, consistent with App.Size()"Documentation only — zero code changes.
Test plan
go build ./...